home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 4 / QRZ Ham Radio Callsign Database - Volume 4.iso / files / packet / bbs / f6fbb / utils / file20.exe / FILE.DOC < prev    next >
Encoding:
Text File  |  1994-10-30  |  14.0 KB  |  324 lines
  1.                 
  2.                 FILE 2.0 (C) 1994 by Dean R. Madsen, KE0WO
  3.  
  4.  
  5.         After numerous requests for an alternative to PICK for automatic
  6. filing of messages,  I have finally found time to create such a program.
  7. Hopefully those that have had little luck getting PICK to function will have
  8. an easier time with FILE.
  9.  
  10.  
  11. Features:
  12.  
  13. Selects messages based on any combination of: the message type, the "From" 
  14. field,  The "To" field, the "@BBS" distribution field, the message bid, and/or
  15. the message subject.
  16.  
  17. The * wildcard is allowed ( *word,  word*,  *word*).
  18.  
  19. Eleven (11) file naming options are supported for files created from selected
  20. messages.
  21.  
  22. Files go to user settable directories.
  23.  
  24. Reads the INIT.SRV file so you don't have to tell the program where the mail
  25. files are or your callsign, etc.
  26.  
  27. The same message may be archived for each search line it qualifies for.
  28.  
  29. An index file may be created.
  30.  
  31. Files maybe added to the YAPPLBL.SYS with a label.
  32.  
  33. The R: forwarding headers may be omitted from the saved files.
  34.  
  35.  
  36.  
  37. Uses:
  38.  
  39. Archive personal mail for later reference...
  40.  
  41. Archive locally generated messages for record keeping/possible
  42. license protection in the US (read "It Seems to Us" in June(?) '94 QST).
  43.  
  44. Allows informational bulletins to be automatically added to file sections.
  45. (ie: ARRL bulletins, RACES bulletins, regional network bulletins.
  46.  
  47.  
  48.  
  49. -----------------------------Installation--------------------------------
  50.  
  51. The only requirement is that all the FILE.* files are located in the same
  52. directory and the FBB 5.15 INIT.SRV is either in the current directory or in
  53. the \FBB directory of the same drive.
  54.  
  55. -----------------------------FILE.ADD------------------------------------
  56. The contents of this file is added to the beginning of each message archived
  57. by FILE.  If the file doesn't exist, or contains no text, nothing is added.
  58. -----------------------------INDEX.FIL--------------------------------------
  59. The contents of the INDEX.FIL becomes each line in the index file.
  60. -----------------------------variables--------------------------------------
  61.  
  62. To permit everyone to tailor this file to their liking, I have implemented
  63. variables to have the FILE program include variable info into the file.
  64. Each variable must begin with a $ and be in lower case.
  65.  
  66.  
  67. Variables:
  68.  
  69. $@        - @BBS field of message being archived.
  70. $@_       - @BBS field formatted to 7 characters.
  71. $thisbbs  - Callsign as found in INIT.SRV.
  72. $to       - "To" field of message being archived.
  73. $to_      - "To" field formatted to 7 characters.
  74. $type     - type of message being archived.
  75. $from     - "from" field of message being archived.
  76. $from_    - "from" field formatted to 7 characters.
  77. $date     - date of message origination in the YYMMDD format
  78. $dateusa  - date of message origination in the U.S. MM/DD/YY format.
  79. $dateeu   - date of message origination in the DD/MM/YY format that everyone 
  80.             else uses.
  81. $time     - time of message origination (hh:mm)
  82. $msize    - size of message/file created from the message.
  83. $bid      - the BID/MID of the message being archived.
  84. $bid_     - the BID/MID formatted to 13 characters.
  85. $subject  - the subject of the message being archived.
  86. $filename - Name of the file the messages is currently being saved to.
  87. $filename_- Name of the file formatted to 14 characters.
  88.  
  89. ------------------------------FILE.CFG--------------------------------------
  90. This is the file where you setup messages to be archived, etc.  All lines
  91. begining with a # are considered comment lines.  Fields are separated by
  92. commas (,).  Currently there is a limit of 173 search lines.  When I tried
  93. to get it set higher I get an error message from my compiler.  This is an area
  94. for improvement in any future versions.  THERE MUST BE NO SPACES _EXCEPT_ IN 
  95. THE SUBJECT SEARCH FIELD!
  96.  
  97.       
  98. again:    THERE MUST BE NO SPACES _EXCEPT_ IN THE SUBJECT SEARCH FIELD!
  99.  
  100. The line format is:
  101.  
  102. Type,From,@BBS,TO,BID/MID,SUBJECT,Drive:\PATH\,Save method,Indexing
  103.  
  104. For right now I will forget the last field (save method) and explain it later.
  105.  
  106. Examples:
  107.  
  108. # Archive all Bulletin type mesages.
  109. B,*,*,*,*,*,C:\BULLETIN\,1,1
  110. # Archive all messages from KE0WO
  111. *,KE0WO,*,*,*,*,C:\KE0WO\,1,1
  112. # Archive all messages with the @ distribution of IOWA
  113. *,*,IOWA,*,*,*,C:\IOWA\,1,1
  114. # Archive all messages to KE0WO
  115. *,*,*,KE0WO,*,*,C:\KE0WO\,1,1
  116. # Archive all messages with a BID/MID ending in _KE0WO  (all messages originated
  117. # on KE0WO BBS)
  118. *,*,*,*,*_KE0WO,*,C:\LOCAL\,1,1
  119. # Archive all messages with the string (case insensitive) "NOAM" in the subject
  120. #  Result:  Archive most of the NA vs. NOAM debate messages.
  121. *,*,*,*,*,*NOAM*,C:\NOAMVSNA\,1,1
  122.  
  123.  
  124. Then you can start combining things to be most specific in message selection:
  125.  
  126.  
  127. # Archive all messages sent to FBB @ ALLUS from anyone with the prefix "KE"
  128. *,KE*,ALLUS,FBB,*,*,C:\FBBSTUFF,1,1
  129. # Archive all personal messages to SYSOP with the work "ILLEGAL" in the subject
  130. P,*,*,SYSOP,*,*ILLEGAL*,C:\SYSOP\,1,1
  131. # Archive all Bulletins messages from KE0BX to MAP* with the distribution of
  132. # IOWA
  133. B,KE0BX,IOWA,MAP*,*,*,C:\FILES\MAPS\,1,1
  134.  
  135.  
  136. Now for the file naming options:
  137.  
  138. 1   -   Save by local message number  (message # 100101 becomes file 100101.)
  139. 2   -   Save by BID/MID
  140. 3   -   Save by name specified in the directory field.  If C:\FILES\STUFF,3
  141.         is the directory/save number.  Messages will be saved as 
  142.         C:\FILES\STUFF.001 to C:\FILES\STUFF.999
  143. 4   -   Save into name.ext (append messages).  If C:\FILES\STUFF.TXT,3
  144.         is the directory/save number.  Messages will be saved as 
  145.         C:\FILES\STUFF.TXT (later messages being appended to the file).
  146. 5   -   Name files using the "From" field of the message being archived.
  147.         Use the extensions .001 - .999
  148. 6   -   Name files using the "From" field of the message being archived.
  149.         Append later messages.
  150. 7   -   Name files using the "to" field of the message being archived.
  151.         Use the extensions .001 - .999
  152. 8   -   Name files using the "to" field of the message being archived.
  153.         Append later messages.
  154. 9   -   Name files using the "@bbs" field of the message being archived.
  155.         Use the extensions .001 - .999
  156. 0   -   Name files using the "@bbs" field of the message being archived.
  157.         Append later messages.
  158. 10  -   Name files using the current date in the YYMMDD format.
  159.         Append later messages.
  160.            
  161. The indexing options:
  162.  
  163. 0   -   No indexing.
  164. 1   -   Create an ASCII index file only
  165. 2   -   Add the file to the YAPPLBL.SYS only so it shows up when the LIST 
  166.         command is used.
  167. 3   -   Create an ASCII index file AND add the file with label to the
  168.         YAPPLBL.SYS.
  169. 4   -   No indexing.  Remove R: forwarding headers.
  170. 5   -   Create an ASCII index file only and remove R: forwarding headers.
  171. 6   -   Add the file to the YAPPLBL.SYS only so it shows up when the LIST
  172.         command is used and remove R: forwarding headers.
  173. 7   -   Create an ASCII index file And add the file with lavl to the
  174.         YAPPLBL.SYS and remove R: forwarding headers.
  175.  
  176. ------------------------------FILE.REJ--------------------------------------
  177. This is basically the REJECT.SYS of the FILE program.  When a match is made
  178. according the settings of FILE.CFG.  FILE looks for a match with the contents
  179. of FILE.REJ,  if it finds a match again, the message WILL NOT be archived.
  180. If FILE.REJ does not exist, then all message matching the FILE.CFG will be
  181. archived.
  182.  
  183. The line format is:
  184.  
  185. Type,From,@BBS,TO,BID/MID,SUBJECT
  186.  
  187. Note this is ALMOST the same as FILE.CFG.
  188.  
  189.  
  190. -------------------------Where to I run this?----------------------
  191.  
  192. In previous programs (REPORT) I assumed that people would realize you run this
  193. type from APPEL.BAT, but from the questions I have received, I should state
  194. that FILE should be run in the APPEL.BAT housekeeping section BEFORE the
  195. EPURMESS program.
  196.  
  197. ------------------------------ BUGS? -------------------------------
  198.    
  199.  
  200.    $m               mm            m        So far I have found the program
  201.     "$mmmmm        m$"    mmmmmmm$"        works fine.  The ONLY problem I
  202.           """$m   m$    m$""""""           can think of is with the naming
  203.         mmmmmmm$$$$$$$$$"mmmm              files by BID/MID.  BID/MIDs can
  204.   mmm$$$$$$$$$$$$$$$$$$ m$$$$m  "    /     be longer than DOS file name as
  205. $$$$$$$$$$$$$$$$$$$$$$  $$$$$$"$$$ /       well as contain characters that
  206.  mmmmmmmmmmmmmmmmmmmmm  $$$$$$$$$$         DOS can't handle in file names..
  207.  $$$$$$$$$$$$$$$$$$$$$  $$$$$$$""" \       I did take some steps to compensate,
  208.  "$$$$$$$$$$$$$$$$$$$$$ $$$$$$  "    \     but I am sure I didn't cover 
  209.      """""""$$$$$$$$$$$m """"              everything.  This is an area of
  210.        mmmmmmmm"  m$   "$mmmmm             improvement for future versions.
  211.      $$""""""      "$     """"""$$
  212.    m$"               "m           "        Another problem may be that the number
  213.                        "                   of seconds since Jan.  1, 1970
  214.                                            is getting larger,  it may get
  215.                                            high enough to cause problems due
  216.                                            the short comings of my compiler.
  217.                                            Usually a run-time error 215 will
  218.                                            signal this happening.  To circumvent
  219.                                            this,  disable the updating of the
  220.                                            YAPPLBL.SYS file throughout the
  221.                                            FILE.CFG.
  222.  
  223. ---------------------Something I almost forgot to mention------------------
  224.  
  225. So the program doesn't archive the same messages next time it is run,  the
  226. file FILE.NUM is created to keep track of the last message the program
  227. processed.  Delete it and the program will look through all messages and then
  228. recreate the file.
  229.  
  230. ------------------------------- Conclusion ---------------------------------
  231.  
  232.  
  233. 1. This software is freeware to the amateur community. It may not be sold.
  234.    It may be freely copied and distributed, but at no charge exceeding the
  235.    medium and shipping.  Commericial use of this software is prohibited
  236.    without licensing from the author.
  237.  
  238. 2. No warranty is expressed or implied and incidental damages resulting from
  239.    the use of this software are solely the responsibility of the user. While
  240.    the software works fine, and I am willing to release it to the amateur 
  241.    community, I am not willing to assume any liabilty for it crashing your
  242.    computer or its peripherals. (It has not done that on any machine I have
  243.    ran it on...this is just legal junk to prevent someone from holding me
  244.    responsible for being generous enough to produce this utility as a 
  245.    service to the FBB community.)
  246.  
  247. 3. Feedback on desired features, bugs, etc. are encouraged. 
  248.  
  249. 4. I have given up on the "send money" type message that used to go here.
  250.    Instead,  how about helping your fellow amateur instead of flaming him?
  251.    If you can make this hobby more enjoyable for others,  then that follows
  252.    the spirit with which my programs are made.  For this, I say "Thank You!".
  253.  
  254. 5. I expect that my release will be UNALTERED.  If I connect to a board and
  255.    find this software package, I expect it to be unchanged and named
  256.    FILE20.EXE.  I don't want to see it as FILE20.ARJ or another name.
  257.    If I take the time to release this software, the least you can do is not 
  258.    change it.
  259.  
  260.  
  261.  
  262.  
  263. If you have any problems, questions, comments, etc. you can contact me via:
  264.  
  265. Telephone: 
  266.  
  267.         Home:     (712) 732-2021
  268.  
  269.         College:  (515) 296-9471    (later part of August, until first part
  270.                                      of December excluding the week long
  271.                                      Thanksgiving break in November.  Second 
  272.                                      semester begins later part of January 
  273.                                      and ends in the first part of May with 
  274.                                      a week long spring break in there 
  275.                                      somewhere.  Some weekends I may be home.
  276.                                      If in doubt, you can call my home # and my
  277.                                      parents will tell you how to reach me.)
  278.  
  279.  
  280. U.S. Mail:
  281.  
  282.         Home:     Dean R. Madsen
  283.                   P.O. Box 303
  284.                   Storm Lake, IA  50588
  285.                   USA
  286.  
  287.         College:  Dean R. Madsen
  288.                   Wallace 7348 Lancelot
  289.                   Iowa State University
  290.                   Ames, IA  50013
  291.                   USA
  292.  
  293. Data :    (712)  732-3767  -   14400,N,8,1 .   Enter your call at the prompt,
  294.                                then type Y to proceed.  
  295.                                Latest KE0WO servers/utilities in the SERVERS
  296.                                subdirectory of my file section in FBBDOS.
  297.  
  298. Internet:         dmadsen@iastate.edu
  299.  
  300. Internet FTP:                  I will try tohave my latest stuff available on my
  301.                                my Internet FTP site for those that want the
  302.                                latest works, or would like to test beta
  303.                                software that I may be working on.
  304.                                FTP vincent.iastate.edu   and login as
  305.                                anonymous.dmadsen  then sent your email
  306.                                address as your password.  I will try to 
  307.                                set up some sort of logical directory
  308.                                structure in the near future.  I plan to have
  309.                                my servers in the directory ke0wo and beta
  310.                                versions in the beta directory.
  311.  
  312.                                I will also try to get my servers to
  313.                                FTP.FUNET.FI somewhere in the
  314.                                /pub/ham/packet/bbs/f6fbb subdiretories.
  315.  
  316.  
  317. Packet Radio:     KE0WO @ KE0WO.#NWIA.IA.USA.NA
  318.  
  319.  
  320. Hope you find this software useful,
  321. 73,
  322. Dean - KE0WO
  323.  
  324.